<!--

     Licensed to the Apache Software Foundation (ASF) under one
     or more contributor license agreements.  See the NOTICE file
     distributed with this work for additional information
     regarding copyright ownership.  The ASF licenses this file
     to you under the Apache License, Version 2.0 (the
     "License"); you may not use this file except in compliance
     with the License.  You may obtain a copy of the License at

       http://www.apache.org/licenses/LICENSE-2.0

     Unless required by applicable law or agreed to in writing,
     software distributed under the License is distributed on an
     "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
     KIND, either express or implied.  See the License for the
     specific language governing permissions and limitations
     under the License.

-->
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<!-- **************************************************************** -->
<!-- *  PLEASE KEEP COMPLICATED EXPRESSIONS OUT OF THESE TEMPLATES, * -->
<!-- *  i.e. only iterate & print data where possible. Thanks, Jez. * -->
<!-- **************************************************************** -->

<html>
<head>
    <!-- Generated by groovydoc (2.4.5) on Mon Sep 12 08:35:17 CEST 2016 -->
    <title>FormLoginHandler (Groovy Documentation)</title>
    <meta name="date" content="2016-09-12">
    <meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
    <link href="../../../../../../groovy.ico" type="image/x-icon" rel="shortcut icon">
    <link href="../../../../../../groovy.ico" type="image/x-icon" rel="icon">
    <link rel="stylesheet" type="text/css" href="../../../../../../stylesheet.css" title="Style">

<body class="center">
<script type="text/javascript"><!--
if (location.href.indexOf('is-external=true') == -1) {
    parent.document.title="FormLoginHandler (Groovy Documentation)";
}
//-->
</script>
<noscript>
    <div>JavaScript is disabled on your browser.</div>
</noscript>
<!-- ========= START OF TOP NAVBAR ======= -->
<div class="topNav"><a name="navbar_top">
    <!--   -->
</a><a href="#skip-navbar_top" title="Skip navigation links"></a><a name="navbar_top_firstrow">
    <!--   -->
</a>
    <ul class="navList" title="Navigation">
        <li><a href="../../../../../../overview-summary.html">Overview</a></li>
        <li><a href="package-summary.html">Package</a></li>
        <li class="navBarCell1Rev">Class</li>
        <li><a href="../../../../../../deprecated-list.html">Deprecated</a></li>
        <li><a href="../../../../../../index-all.html">Index</a></li>
        <li><a href="../../../../../../help-doc.html">Help</a></li>
    </ul>
</div>

<div class="subNav">
    <div>
        <ul class="navList">
            <li><a href="../../../../../../index.html?io/vertx/groovy/ext/web/handler/FormLoginHandler" target="_top">Frames</a></li>
            <li><a href="FormLoginHandler.html" target="_top">No Frames</a></li>
        </ul>
    </div>
    <div>
        <ul class="subNavList">
            <li>Summary:&nbsp;</li>
            Nested&nbsp;&nbsp;&nbsp;Field&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<li><a href="#constructor_summary">Constructor</a></li>&nbsp;&nbsp;&nbsp;<li><a href="#method_summary">Method</a></li>&nbsp;&nbsp;&nbsp;
        </ul>
        <ul class="subNavList">
            <li>&nbsp;|&nbsp;Detail:&nbsp;</li>
            Field&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<li><a href="#constructor_detail">Constructor</a></li>&nbsp;&nbsp;&nbsp;<li><a href="#method_detail">Method</a></li>&nbsp;&nbsp;&nbsp;
        </ul>
    </div>
    <a name="skip-navbar_top">
        <!--   -->
    </a></div>
<!-- ========= END OF TOP NAVBAR ========= -->

<!-- ======== START OF CLASS DATA ======== -->
<div class="header">

    <div class="subTitle">Package: <strong>io.vertx.groovy.ext.web.handler</strong></div>

    <h2 title="[Groovy] Class FormLoginHandler" class="title">[Groovy] Class FormLoginHandler</h2>
</div>
<div class="contentContainer">
<ul class="inheritance">
<li><ul class="inheritance"></ul></li><li>io.vertx.groovy.ext.web.handler.FormLoginHandler
</ul>
<div class="description">
    <ul class="blockList">
        <li class="blockList">

            <dl>
                <dt>All Implemented Interfaces and Traits:</dt>
                <dd>io.vertx.core.Handler</dd>
            </dl>
            <!-- todo: direct known subclasses -->
            <hr>
            <br>
<pre>@groovy.transform.CompileStatic
class FormLoginHandler
extends java.lang.Object

</pre>



    <p> Handler that handles login from a form on a custom login page.
 <p>
 Used in conjunction with the <a href='../../../../../../io/vertx/groovy/ext/web/handler/RedirectAuthHandler.html' title='RedirectAuthHandler'>RedirectAuthHandler</a>.
</p>

          </li>
    </ul>
</div>

<div class="summary">
    <ul class="blockList">
        <li class="blockList">
        <!-- =========== NESTED CLASS SUMMARY =========== -->
        

        <!-- =========== ENUM CONSTANT SUMMARY =========== -->
        
        <!-- =========== FIELD SUMMARY =========== -->
        

        <!-- =========== PROPERTY SUMMARY =========== -->
        

        <!-- =========== ELEMENT SUMMARY =========== -->
        

        
        <!-- ======== CONSTRUCTOR SUMMARY ======== -->
        <ul class="blockList">
                <li class="blockList"><a name="constructor_summary"><!--   --></a>
                    <h3>Constructor Summary</h3>
                    <ul class="blockList">
                    <table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Constructors Summary table">
                        <caption><span>Constructors</span><span class="tabEnd">&nbsp;</span></caption>
                        <tr>
                            <th class="colFirst" scope="col">Constructor and description</th>
                        </tr>
                        
                        <tr class="altColor">
                            <td class="colFirst">
                                <code><a href="#FormLoginHandler(java.lang.Object)">FormLoginHandler</a></strong>
                                (java.lang.Object delegate)</code><br></td>
                        </tr>
                        
                    </table>
                   </ul>
              </li>
        </ul>
        

        
        <!-- ========== METHOD SUMMARY =========== -->
        <ul class="blockList">
            
            <li class="blockList"><a name="method_summary"><!--   --></a>
                    <h3>Methods Summary</h3>
                    <ul class="blockList">
                    <table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Methods Summary table">
                        <caption><span>Methods</span><span class="tabEnd">&nbsp;</span></caption>
                        <tr>
                            <th class="colFirst" scope="col">Type</th>
                            <th class="colLast" scope="col">Name and description</th>
                        </tr>
                        
                        <tr class="altColor">
                            <td class="colFirst"><code>static&nbsp;<a href='../../../../../../io/vertx/groovy/ext/web/handler/FormLoginHandler.html'>FormLoginHandler</a></strong></code></td>
                            <td class="colLast"><code><strong><a href="#create(io.vertx.groovy.ext.auth.AuthProvider)">create</a></strong>(<a href='../../../../../../io/vertx/groovy/ext/auth/AuthProvider.html'>AuthProvider</a> authProvider)</code><br>Create a handler</td>
                        </tr>
                        
                        <tr class="rowColor">
                            <td class="colFirst"><code>static&nbsp;<a href='../../../../../../io/vertx/groovy/ext/web/handler/FormLoginHandler.html'>FormLoginHandler</a></strong></code></td>
                            <td class="colLast"><code><strong><a href="#create(io.vertx.groovy.ext.auth.AuthProvider, java.lang.String, java.lang.String, java.lang.String, java.lang.String)">create</a></strong>(<a href='../../../../../../io/vertx/groovy/ext/auth/AuthProvider.html'>AuthProvider</a> authProvider, java.lang.String usernameParam, java.lang.String passwordParam, java.lang.String returnURLParam, java.lang.String directLoggedInOKURL)</code><br>Create a handler</td>
                        </tr>
                        
                        <tr class="altColor">
                            <td class="colFirst"><code>java.lang.Object</strong></code></td>
                            <td class="colLast"><code><strong><a href="#getDelegate()">getDelegate</a></strong>()</code><br></td>
                        </tr>
                        
                        <tr class="rowColor">
                            <td class="colFirst"><code>void</strong></code></td>
                            <td class="colLast"><code><strong><a href="#handle(io.vertx.groovy.ext.web.RoutingContext)">handle</a></strong>(<a href='../../../../../../io/vertx/groovy/ext/web/RoutingContext.html'>RoutingContext</a> arg0)</code><br></td>
                        </tr>
                        
                        <tr class="altColor">
                            <td class="colFirst"><code><a href='../../../../../../io/vertx/groovy/ext/web/handler/FormLoginHandler.html'>FormLoginHandler</a></strong></code></td>
                            <td class="colLast"><code><strong><a href="#setDirectLoggedInOKURL(java.lang.String)">setDirectLoggedInOKURL</a></strong>(java.lang.String directLoggedInOKURL)</code><br>Set the url to redirect to if the user logs in directly at the url of the form login handler
 without being redirected here first</td>
                        </tr>
                        
                        <tr class="rowColor">
                            <td class="colFirst"><code><a href='../../../../../../io/vertx/groovy/ext/web/handler/FormLoginHandler.html'>FormLoginHandler</a></strong></code></td>
                            <td class="colLast"><code><strong><a href="#setPasswordParam(java.lang.String)">setPasswordParam</a></strong>(java.lang.String passwordParam)</code><br>Set the name of the form param used to submit the password</td>
                        </tr>
                        
                        <tr class="altColor">
                            <td class="colFirst"><code><a href='../../../../../../io/vertx/groovy/ext/web/handler/FormLoginHandler.html'>FormLoginHandler</a></strong></code></td>
                            <td class="colLast"><code><strong><a href="#setReturnURLParam(java.lang.String)">setReturnURLParam</a></strong>(java.lang.String returnURLParam)</code><br>Set the name of the session attrioute used to specify the return url</td>
                        </tr>
                        
                        <tr class="rowColor">
                            <td class="colFirst"><code><a href='../../../../../../io/vertx/groovy/ext/web/handler/FormLoginHandler.html'>FormLoginHandler</a></strong></code></td>
                            <td class="colLast"><code><strong><a href="#setUsernameParam(java.lang.String)">setUsernameParam</a></strong>(java.lang.String usernameParam)</code><br>Set the name of the form param used to submit the username</td>
                        </tr>
                        
                    </table>
                   </ul>
              </li>
            
            <li class="blockList"><a name="method_summary"><!--   --></a>
                    <h3>Inherited Methods Summary</h3>
                    <ul class="blockList">
                    <table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Inherited Methods Summary table">
                        <caption><span>Inherited Methods</span><span class="tabEnd">&nbsp;</span></caption>
                        <tr>
                            <th class="colFirst" scope="col">Methods inherited from class</th>
                            <th class="colLast" scope="col">Name</th>
                        </tr>
                        
                        <tr class="altColor">
                            <td class="colFirst"><code>class java.lang.Object</strong></code></td>
                            <td class="colLast"><code>java.lang.Object#wait(long, int), java.lang.Object#wait(long), java.lang.Object#wait(), java.lang.Object#equals(java.lang.Object), java.lang.Object#toString(), java.lang.Object#hashCode(), java.lang.Object#getClass(), java.lang.Object#notify(), java.lang.Object#notifyAll()</code></td>
                        </tr>
                    </table>
                   </ul>
              </li>
                
        </ul>
        
    </li>
    </ul>
</div>

<div class="details">
    <ul class="blockList">
        <li class="blockList">
           

            

            

            

            
            <!-- =========== CONSTRUCTOR DETAIL =========== -->
            <ul class="blockList">
                <li class="blockList"><a name="constructor_detail">
                    <!--   -->
                </a>
                    <h3>Constructor Detail</h3>
                    
                        <a name="FormLoginHandler(java.lang.Object)"><!-- --></a>
                        <ul class="blockListLast">
                            <li class="blockList">
                                <h4><strong>FormLoginHandler</strong>(java.lang.Object delegate)</h4>
                                <p></p>
                            </li>
                        </ul>
                    
                </li>
            </ul>
            


            
            <!-- =========== METHOD DETAIL =========== -->
            <ul class="blockList">
                <li class="blockList"><a name="method_detail">
                    <!--   -->
                </a>
                    <h3>Method Detail</h3>
                    
                        <a name="create(io.vertx.groovy.ext.auth.AuthProvider)"><!-- --></a>
                        <ul class="blockListLast">
                            <li class="blockList">
                                <h4>static&nbsp;<a href='../../../../../../io/vertx/groovy/ext/web/handler/FormLoginHandler.html'>FormLoginHandler</a> <strong>create</strong>(<a href='../../../../../../io/vertx/groovy/ext/auth/AuthProvider.html'>AuthProvider</a> authProvider)</h4>
                                <p> Create a handler
   <DL><DT><B>Returns:</B></DT><DD>the handler</DD></DL><DL><DT><B>Parameters:</B></DT><DD><code>authProvider</code> -  the auth service to use</DD></DL></p>
                            </li>
                        </ul>
                    
                        <a name="create(io.vertx.groovy.ext.auth.AuthProvider, java.lang.String, java.lang.String, java.lang.String, java.lang.String)"><!-- --></a>
                        <ul class="blockListLast">
                            <li class="blockList">
                                <h4>static&nbsp;<a href='../../../../../../io/vertx/groovy/ext/web/handler/FormLoginHandler.html'>FormLoginHandler</a> <strong>create</strong>(<a href='../../../../../../io/vertx/groovy/ext/auth/AuthProvider.html'>AuthProvider</a> authProvider, java.lang.String usernameParam, java.lang.String passwordParam, java.lang.String returnURLParam, java.lang.String directLoggedInOKURL)</h4>
                                <p> Create a handler
   <DL><DT><B>Returns:</B></DT><DD>the handler</DD></DL><DL><DT><B>Parameters:</B></DT><DD><code>authProvider</code> -  the auth service to use</DD><DD><code>usernameParam</code> -  the value of the form attribute which will contain the username</DD><DD><code>passwordParam</code> -  the value of the form attribute which will contain the password</DD><DD><code>returnURLParam</code> -  the value of the session attribute which will contain the return url</DD><DD><code>directLoggedInOKURL</code> -  a url to redirect to if the user logs in directly at the url of the form login handler without being redirected here first</DD></DL></p>
                            </li>
                        </ul>
                    
                        <a name="getDelegate()"><!-- --></a>
                        <ul class="blockListLast">
                            <li class="blockList">
                                <h4>java.lang.Object <strong>getDelegate</strong>()</h4>
                                <p></p>
                            </li>
                        </ul>
                    
                        <a name="handle(io.vertx.groovy.ext.web.RoutingContext)"><!-- --></a>
                        <ul class="blockListLast">
                            <li class="blockList">
                                <h4>void <strong>handle</strong>(<a href='../../../../../../io/vertx/groovy/ext/web/RoutingContext.html'>RoutingContext</a> arg0)</h4>
                                <p></p>
                            </li>
                        </ul>
                    
                        <a name="setDirectLoggedInOKURL(java.lang.String)"><!-- --></a>
                        <ul class="blockListLast">
                            <li class="blockList">
                                <h4><a href='../../../../../../io/vertx/groovy/ext/web/handler/FormLoginHandler.html'>FormLoginHandler</a> <strong>setDirectLoggedInOKURL</strong>(java.lang.String directLoggedInOKURL)</h4>
                                <p> Set the url to redirect to if the user logs in directly at the url of the form login handler
 without being redirected here first
   <DL><DT><B>Returns:</B></DT><DD>a reference to this for a fluent API</DD></DL><DL><DT><B>Parameters:</B></DT><DD><code>directLoggedInOKURL</code> -  the URL to redirect to</DD></DL></p>
                            </li>
                        </ul>
                    
                        <a name="setPasswordParam(java.lang.String)"><!-- --></a>
                        <ul class="blockListLast">
                            <li class="blockList">
                                <h4><a href='../../../../../../io/vertx/groovy/ext/web/handler/FormLoginHandler.html'>FormLoginHandler</a> <strong>setPasswordParam</strong>(java.lang.String passwordParam)</h4>
                                <p> Set the name of the form param used to submit the password
   <DL><DT><B>Returns:</B></DT><DD>a reference to this for a fluent API</DD></DL><DL><DT><B>Parameters:</B></DT><DD><code>passwordParam</code> -  the name of the param</DD></DL></p>
                            </li>
                        </ul>
                    
                        <a name="setReturnURLParam(java.lang.String)"><!-- --></a>
                        <ul class="blockListLast">
                            <li class="blockList">
                                <h4><a href='../../../../../../io/vertx/groovy/ext/web/handler/FormLoginHandler.html'>FormLoginHandler</a> <strong>setReturnURLParam</strong>(java.lang.String returnURLParam)</h4>
                                <p> Set the name of the session attrioute used to specify the return url
   <DL><DT><B>Returns:</B></DT><DD>a reference to this for a fluent API</DD></DL><DL><DT><B>Parameters:</B></DT><DD><code>returnURLParam</code> -  the name of the param</DD></DL></p>
                            </li>
                        </ul>
                    
                        <a name="setUsernameParam(java.lang.String)"><!-- --></a>
                        <ul class="blockListLast">
                            <li class="blockList">
                                <h4><a href='../../../../../../io/vertx/groovy/ext/web/handler/FormLoginHandler.html'>FormLoginHandler</a> <strong>setUsernameParam</strong>(java.lang.String usernameParam)</h4>
                                <p> Set the name of the form param used to submit the username
   <DL><DT><B>Returns:</B></DT><DD>a reference to this for a fluent API</DD></DL><DL><DT><B>Parameters:</B></DT><DD><code>usernameParam</code> -  the name of the param</DD></DL></p>
                            </li>
                        </ul>
                    
                </li>
            </ul>
            
        </li>
    </ul>
</div>

<!-- ========= END OF CLASS DATA ========= -->
<!-- ======= START OF BOTTOM NAVBAR ====== -->
<div class="bottomNav"><a name="navbar_bottom">
    <!--   -->
</a><a href="#skip-navbar_bottom" title="Skip navigation links"></a><a name="navbar_bottom_firstrow">
    <!--   -->
</a>
    <ul class="navList" title="Navigation">
        <li><a href="../../../../../../overview-summary.html">Overview</a></li>
        <li><a href="package-summary.html">Package</a></li>
        <li class="navBarCell1Rev">Class</li>
        <li><a href="../../../../../../deprecated-list.html">Deprecated</a></li>
        <li><a href="../../../../../../index-all.html">Index</a></li>
        <li><a href="../../../../../../help-doc.html">Help</a></li>
    </ul>
</div>

<div class="subNav">
    <div>
        <ul class="navList">
            <li><a href="../../../../../../index.html?io/vertx/groovy/ext/web/handler/FormLoginHandler" target="_top">Frames</a></li>
            <li><a href="FormLoginHandler.html" target="_top">No Frames</a></li>
        </ul>
    </div>
    <div>
        <ul class="subNavList">
            <li>Summary:&nbsp;</li>
            Nested&nbsp;&nbsp;&nbsp;Field&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<li><a href="#constructor_summary">Constructor</a></li>&nbsp;&nbsp;&nbsp;<li><a href="#method_summary">Method</a></li>&nbsp;&nbsp;&nbsp;
        </ul>
        <ul class="subNavList">
            <li>&nbsp;|&nbsp;Detail:&nbsp;</li>
            Field&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<li><a href="#constructor_detail">Constructor</a></li>&nbsp;&nbsp;&nbsp;<li><a href="#method_detail">Method</a></li>&nbsp;&nbsp;&nbsp;
        </ul>
    </div>
    <p>Groovy Documentation</p>
    <a name="skip-navbar_bottom">
        <!--   -->
    </a>
    </div>
</div>
<!-- ======== END OF BOTTOM NAVBAR ======= -->
</body>
</html>